// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2024-08-01

package types

import "time"

var (
	earliestDatetime = time.Unix(0, 0)
)

// Datetime
// is a type name for datetime format in a table.
//
//	type Example struct{
//	    ...
//	    CreatedAt db.Datetime `json:"created_at" xorm:"created_at"` // 2024-09-10 11:22:33
//	    UpdatedAt db.Datetime `json:"updated_at" xorm:"updated_at"` // 2024-09-01 12:34:56
//	    ...
//	}
//
//	func (o *Example) TableName() string {
//	    return "example"
//	}
type Datetime string

// NewDatetime
// creates an object based on current system time.
func NewDatetime() Datetime {
	return Datetime(time.Now().Format(time.DateTime))
}

// String
// convert to a string.
func (o Datetime) String() string {
	return string(o)
}

// Time
// convert to time.Time.
func (o Datetime) Time() time.Time {
	if t, err := time.ParseInLocation(time.DateTime, o.String(), loc); err == nil {
		return t
	}
	return earliestDatetime
}
